Skip to content

docs(llama.cpp): fix default GGUF quickstart#3234

Merged
LauraGPT merged 4 commits into
mainfrom
codex/llamacpp-release-discovery-20260715
Jul 15, 2026
Merged

docs(llama.cpp): fix default GGUF quickstart#3234
LauraGPT merged 4 commits into
mainfrom
codex/llamacpp-release-discovery-20260715

Conversation

@LauraGPT

@LauraGPT LauraGPT commented Jul 15, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • align both root README quickstarts with the default sensevoice-small-q8.gguf downloaded by the helper
  • make the packaged commands executable as copied: ./llama-funasr-sensevoice on Linux/macOS and .\llama-funasr-sensevoice.exe from the Windows ZIP root
  • add a scoped downloader/README contract test and a lightweight PR/push workflow that runs it
  • use an absolute Releases URL so the quickstart remains valid outside GitHub

Root cause

The downloader defaults to the practical Q8 SenseVoice artifact, while the English root README invoked the old, differently cased SenseVoiceSmall-f16.gguf filename. The release archives also do not install their binaries into PATH, so the Unix command needed ./; the Chinese root README had only a pointer rather than an equivalent copy-paste flow.

The existing downloader contract was not connected to CI and searched whole README files. It now extracts the CPU/edge Bash and PowerShell fences, derives the expected SenseVoice filename from the downloader's observed request, and requires complete runnable command lines for both platforms.

Validation

  • reproduced the stale-filename and missing-executable-path failures before the fixes
  • mutation-tested that commands outside the CPU/edge fence, missing Windows downloads, and commented-out commands are rejected
  • bash runtime/llama.cpp/tests/test_download_funasr_model.sh
  • bash -n runtime/llama.cpp/tests/test_download_funasr_model.sh runtime/llama.cpp/download-funasr-model.sh
  • git diff --check
  • GitHub Actions contract job
  • verified the v0.1.6 Linux x64 and Windows x64 assets against their published SHA-256 digests; archive listings place both platform binaries at the documented roots
  • executed ./llama-funasr-sensevoice --help from the extracted Linux x64 release
  • verified the Releases, funasr.com quickstart, and Hugging Face links return HTTP 200

Signed-off-by: 游雁 <zhifu.gzf@alibaba-inc.com>

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the default SenseVoice model filename to sensevoice-small-q8.gguf in the quickstart documentation for both English and Chinese READMEs, and introduces a test script to assert that these README commands remain up-to-date. The reviewer suggested using an absolute URL for the releases link in README_zh.md to ensure portability across different platforms.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread README_zh.md Outdated
LauraGPT added 3 commits July 15, 2026 05:34
Signed-off-by: 游雁 <zhifu.gzf@alibaba-inc.com>
Signed-off-by: 游雁 <zhifu.gzf@alibaba-inc.com>
Signed-off-by: 游雁 <zhifu.gzf@alibaba-inc.com>
@LauraGPT LauraGPT marked this pull request as ready for review July 15, 2026 05:42
@LauraGPT LauraGPT requested a review from yuekaizhang July 15, 2026 06:44
@LauraGPT LauraGPT merged commit 68a21aa into main Jul 15, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant